home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2002 November / SGI IRIX Base Documentation 2002 November.iso / usr / share / catman / p_man / cat3 / SCSL / csytf2.z / csytf2
Encoding:
Text File  |  2002-10-03  |  6.7 KB  |  199 lines
  1.  
  2.  
  3.  
  4. CCCCSSSSYYYYTTTTFFFF2222((((3333SSSS))))                                                          CCCCSSSSYYYYTTTTFFFF2222((((3333SSSS))))
  5.  
  6.  
  7.  
  8. NNNNAAAAMMMMEEEE
  9.      CSYTF2 - compute the factorization of a complex symmetric matrix A using
  10.      the Bunch-Kaufman diagonal pivoting method
  11.  
  12. SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  13.      SUBROUTINE CSYTF2( UPLO, N, A, LDA, IPIV, INFO )
  14.  
  15.          CHARACTER      UPLO
  16.  
  17.          INTEGER        INFO, LDA, N
  18.  
  19.          INTEGER        IPIV( * )
  20.  
  21.          COMPLEX        A( LDA, * )
  22.  
  23. IIIIMMMMPPPPLLLLEEEEMMMMEEEENNNNTTTTAAAATTTTIIIIOOOONNNN
  24.      These routines are part of the SCSL Scientific Library and can be loaded
  25.      using either the -lscs or the -lscs_mp option.  The -lscs_mp option
  26.      directs the linker to use the multi-processor version of the library.
  27.  
  28.      When linking to SCSL with -lscs or -lscs_mp, the default integer size is
  29.      4 bytes (32 bits). Another version of SCSL is available in which integers
  30.      are 8 bytes (64 bits).  This version allows the user access to larger
  31.      memory sizes and helps when porting legacy Cray codes.  It can be loaded
  32.      by using the -lscs_i8 option or the -lscs_i8_mp option. A program may use
  33.      only one of the two versions; 4-byte integer and 8-byte integer library
  34.      calls cannot be mixed.
  35.  
  36. PPPPUUUURRRRPPPPOOOOSSSSEEEE
  37.      CSYTF2 computes the factorization of a complex symmetric matrix A using
  38.      the Bunch-Kaufman diagonal pivoting method:
  39.         A = U*D*U'  or  A = L*D*L'
  40.  
  41.      where U (or L) is a product of permutation and unit upper (lower)
  42.      triangular matrices, U' is the transpose of U, and D is symmetric and
  43.      block diagonal with 1-by-1 and 2-by-2 diagonal blocks.
  44.  
  45.      This is the unblocked version of the algorithm, calling Level 2 BLAS.
  46.  
  47.  
  48. AAAARRRRGGGGUUUUMMMMEEEENNNNTTTTSSSS
  49.      UPLO    (input) CHARACTER*1
  50.              Specifies whether the upper or lower triangular part of the
  51.              symmetric matrix A is stored:
  52.              = 'U':  Upper triangular
  53.              = 'L':  Lower triangular
  54.  
  55.      N       (input) INTEGER
  56.              The order of the matrix A.  N >= 0.
  57.  
  58.  
  59.  
  60.  
  61.  
  62.  
  63.                                                                         PPPPaaaaggggeeee 1111
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. CCCCSSSSYYYYTTTTFFFF2222((((3333SSSS))))                                                          CCCCSSSSYYYYTTTTFFFF2222((((3333SSSS))))
  71.  
  72.  
  73.  
  74.      A       (input/output) COMPLEX array, dimension (LDA,N)
  75.              On entry, the symmetric matrix A.  If UPLO = 'U', the leading n-
  76.              by-n upper triangular part of A contains the upper triangular
  77.              part of the matrix A, and the strictly lower triangular part of A
  78.              is not referenced.  If UPLO = 'L', the leading n-by-n lower
  79.              triangular part of A contains the lower triangular part of the
  80.              matrix A, and the strictly upper triangular part of A is not
  81.              referenced.
  82.  
  83.              On exit, the block diagonal matrix D and the multipliers used to
  84.              obtain the factor U or L (see below for further details).
  85.  
  86.      LDA     (input) INTEGER
  87.              The leading dimension of the array A.  LDA >= max(1,N).
  88.  
  89.      IPIV    (output) INTEGER array, dimension (N)
  90.              Details of the interchanges and the block structure of D.  If
  91.              IPIV(k) > 0, then rows and columns k and IPIV(k) were
  92.              interchanged and D(k,k) is a 1-by-1 diagonal block.  If UPLO =
  93.              'U' and IPIV(k) = IPIV(k-1) < 0, then rows and columns k-1 and
  94.              -IPIV(k) were interchanged and D(k-1:k,k-1:k) is a 2-by-2
  95.              diagonal block.  If UPLO = 'L' and IPIV(k) = IPIV(k+1) < 0, then
  96.              rows and columns k+1 and -IPIV(k) were interchanged and
  97.              D(k:k+1,k:k+1) is a 2-by-2 diagonal block.
  98.  
  99.      INFO    (output) INTEGER
  100.              = 0: successful exit
  101.              < 0: if INFO = -k, the k-th argument had an illegal value
  102.              > 0: if INFO = k, D(k,k) is exactly zero.  The factorization has
  103.              been completed, but the block diagonal matrix D is exactly
  104.              singular, and division by zero will occur if it is used to solve
  105.              a system of equations.
  106.  
  107. FFFFUUUURRRRTTTTHHHHEEEERRRR DDDDEEEETTTTAAAAIIIILLLLSSSS
  108.      1-96 - Based on modifications by J. Lewis, Boeing Computer Services
  109.             Company
  110.  
  111.      If UPLO = 'U', then A = U*D*U', where
  112.         U = P(n)*U(n)* ... *P(k)U(k)* ...,
  113.      i.e., U is a product of terms P(k)*U(k), where k decreases from n to 1 in
  114.      steps of 1 or 2, and D is a block diagonal matrix with 1-by-1 and 2-by-2
  115.      diagonal blocks D(k).  P(k) is a permutation matrix as defined by
  116.      IPIV(k), and U(k) is a unit upper triangular matrix, such that if the
  117.      diagonal block D(k) is of order s (s = 1 or 2), then
  118.  
  119.                 (   I    v    0   )   k-s
  120.         U(k) =  (   0    I    0   )   s
  121.                 (   0    0    I   )   n-k
  122.                    k-s   s   n-k
  123.  
  124.      If s = 1, D(k) overwrites A(k,k), and v overwrites A(1:k-1,k).  If s = 2,
  125.      the upper triangle of D(k) overwrites A(k-1,k-1), A(k-1,k), and A(k,k),
  126.  
  127.  
  128.  
  129.                                                                         PPPPaaaaggggeeee 2222
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136. CCCCSSSSYYYYTTTTFFFF2222((((3333SSSS))))                                                          CCCCSSSSYYYYTTTTFFFF2222((((3333SSSS))))
  137.  
  138.  
  139.  
  140.      and v overwrites A(1:k-2,k-1:k).
  141.  
  142.      If UPLO = 'L', then A = L*D*L', where
  143.         L = P(1)*L(1)* ... *P(k)*L(k)* ...,
  144.      i.e., L is a product of terms P(k)*L(k), where k increases from 1 to n in
  145.      steps of 1 or 2, and D is a block diagonal matrix with 1-by-1 and 2-by-2
  146.      diagonal blocks D(k).  P(k) is a permutation matrix as defined by
  147.      IPIV(k), and L(k) is a unit lower triangular matrix, such that if the
  148.      diagonal block D(k) is of order s (s = 1 or 2), then
  149.  
  150.                 (   I    0     0   )  k-1
  151.         L(k) =  (   0    I     0   )  s
  152.                 (   0    v     I   )  n-k-s+1
  153.                    k-1   s  n-k-s+1
  154.  
  155.      If s = 1, D(k) overwrites A(k,k), and v overwrites A(k+1:n,k).  If s = 2,
  156.      the lower triangle of D(k) overwrites A(k,k), A(k+1,k), and A(k+1,k+1),
  157.      and v overwrites A(k+2:n,k:k+1).
  158.  
  159.  
  160. SSSSEEEEEEEE AAAALLLLSSSSOOOO
  161.      INTRO_LAPACK(3S), INTRO_SCSL(3S)
  162.  
  163.      This man page is available only online.
  164.  
  165.  
  166.  
  167.  
  168.  
  169.  
  170.  
  171.  
  172.  
  173.  
  174.  
  175.  
  176.  
  177.  
  178.  
  179.  
  180.  
  181.  
  182.  
  183.  
  184.  
  185.  
  186.  
  187.  
  188.  
  189.  
  190.  
  191.  
  192.  
  193.  
  194.  
  195.                                                                         PPPPaaaaggggeeee 3333
  196.  
  197.  
  198.  
  199.